OpenBuildings™ Station Designer Help

Add Instance Data

Used to add catalog item and instance data to graphic elements to allow such business data to be included in queries, reports and schedules.

Accessed from:


  • Ribbon: Building Design > Data/Reporting > Data > Add split button > Attach

Add Instance Data Options tab

Selection of the tool opens a contextual ribbon tab in the Building Design > ribbon. The Add Data tab contains options for adding instance data and settings used to control the association of data instance to a building element.
SettingDescription
Use Model Properties Enabled when the active model has the Ability to Place > As Annotation Cell option enabled in its model properties (i.e. Model Properties > Cell > Can be Placed as AnnotationCell is True).

When on, catalog data is placed with each cell instance. When off, catalog data is added to existing selected cells.

Use Fence Enabled when there is an active fence. When on, catalog item instances are selected according to the selected Fence mode.
Fence Mode
  • Inside - Only the catalog item instances completely inside the fence are selected.
  • Overlap - instances inside or overlapping the fence are selected.
  • Clip - instances completely inside the fence and parts of elements inside and overlapping the fence are selected.
  • Void - instances completely outside the fence are selected.
  • Void-Overlap - instances outside or overlapping the fence are selected.
  • Void-Clip - instances completely outside and those parts of elements outside and overlapping the fence are selected.

Add Instance Data Properties



Note: The Show/Hide Preview panel is not applicable for this interface. Refer to the thumbnail of selected catalog item.
SettingDescription
Catalog Type Selector Displays catalog types hierarchically arranged based on Building discipline, making it easier to navigate to desired catalog types. All Catalog Types available in the application, including imported ones like the RFAs, if any are listed here. Selects the catalog type (e.g. Door, Window, etc) which populates the Instance Data Properties. Selections made here updates the Catalog Item Selector combo box below it.
Catalog Item Selector Used to select from available Catalog Items. The Catalog Item Selector combo box contains several options and settings designed to make it easier to find the exact catalog item you need to place/change.

A generic example of Catalog Item selector options for searching, grouping and navigating

The Catalog Item list also includes user defined assemblies, and RFA catalog items, if any.
  • Search - Used to search for catalog items by name. Results are dynamically updated in the catalog items list. The searched text is also highlighted in the results.
  • Group By: - Used to list catalog items in groups based on values assigned to specific catalog item properties. Groups can be collapsed and expanded by clicking the down/up arrows on the group name headers. For instance, selecting Group By: > Type for a wall catalog type creates groupings with Schematic, Partition, WallComponent, etc headings. Catalog items which have Type defined as Schematic, Partition, or WallComponent will be listed under those headings. You can also select Group By: > Do Not Group to create a flat list with no grouping. (Exemption Mechanical).
  • (Large Icons) - Displays a representative icon for each catalog item listing.
  • (List) - Displays catalog item listings without any icons.
  • (Float) - When selected, the Catalog Item Selector combo box is detached from the placement/modify dialog, and becomes a separate dialog. You may prefer to have the floated dialog docked and always open over clicking the Catalog Item Selector in the placement/modify dialog for each catalog item selection.
    Note: The main dialog remains open and refreshes the thumbnail and preview in response to the selected catalog item.
    Click the Dock icon to close the floated dialog.
  • Recently Used - Lists catalog items that were recently selected in a "Group". This is useful because when you need to repeatedly place or modify the same catalog items, you do not need to repeatedly browse or search the main catalog items list.
Note: When you make your catalog item selection, it becomes the active part the Family/Part Toolbar.
Catalog Tools A split button located to the right of the Catalog Item Selector contains tools to assist with managing catalog data prior to placement of selected catalog items.
  • ( Match Element Properties) - Sets the current active placement/modify dialog settings to match the parameters of an existing, selected catalog item instance in the model. This saves a good amount of time when placing catalog items that need to identically match those that already exist.
    Note: The existing catalog item instance must be of the same catalog type selected with the Catalog Item Selector for the parameters to be matched.
  • (Reset to Defaults) - Resets the selected catalog item property values to the default state as defined in the catalog library.
  • (Edit Catalog Item) - Used to edit the selected catalog item. Opens the Catalog Editor, where you can create and edit new catalog types and catalog items. Catalog Editor can also be used to edit existing data and to view catalog item instance properties and values by definition.
  • (Catalog Item Manager) - Used to manage catalog items library into organizational dataset. Opens the Catalog Item Manager, where you can copy or move catalog items into the dataset, and promoting current catalog items by moving then across workset levels.
  • (Save Catalog Item) - Updates the active catalog item in the DataGroup System catalog library with the values currently shown in the Properties list box permanently changing the defaults for the catalog item.
  • (Save Catalog Item As...) - Used to save a copy of the selected catalog item as another catalog item (the default name adds the prefix " Copy of " <current catalog items name>). Opens the Save As dialog where catalog item definitions can be named before saving them to the DataGroup System.
Note: The Save Catalog Item and Save Catalog Item As... tools perform administrative tasks on DataGroup System catalogs. Administrators and users may want to hide the tool icons to avoid incidental or unwanted changes to their firm's dataset by setting the user configuration variables BB_CATALOGITEM_ADMIN_IN_PLACECMDS and BB_CATALOGITEM_SAVEAS_IN_PLACECMDS to "0", respectively.
Properties list Used to manage catalog item properties during attaching instance data. Catalog item properties define the catalog item instance in the model, and are accountable in the DataGroup System data management tools. You can place a catalog item with its default property values or you can change property values as needed, add an instance in the model, and optionally save the changes to the catalog.

The Properties combo box contains tools for sorting and searching the properties list:

  • (Categorize) - When on, catalog item properties are grouped in categories based on the catalog type definitions. When off, the properties are listed alphabetically without grouping.
  • (Alphabetical) - When on, catalog item properties are listed alphabetically without grouping. When off, the properties are listed in categories.
  • (Description) - Toggles a description field at the bottom of the placement dialog listing information about the highlighted catalog item property. The information listed includes the property definition display name, internal name, and type definition.
  • Search - Used to search for catalog item properties by name. Results are dynamically updated in the properties list.

Information in the Value column rows can be completed by selecting the applicable cell to activate an editor field, an option menu, or a pop up dialog. This data is written to the element properties. Properties displayed with grey text are read only. The dividing bar between the Property, and Value columns can be moved to change the width of either area, or resize the dialog. A vertical and a horizontal scroll bars are available to scroll and adjust Properties panel viewing and the display of data.

Note: The property categories listed in the panel vary depending upon the active catalog instance (and the discipline the catalog item belongs). Unlike in placement, the properties in add instance workflow have limited options, e.g. the Mechanical context menus and settings through context activated dialog, etc.)
Key-in: DG ADD DATA